//
// Encog(tm) Core v3.3 - .Net Version
// http://www.heatonresearch.com/encog/
//
// Copyright 2008-2014 Heaton Research, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//  http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//   
// For more information on Heaton Research copyrights, licenses 
// and trademarks visit:
// http://www.heatonresearch.com/copyright
//
namespace Encog.ML.Data.Versatile.Division
{
    /// <summary>
    /// A division of data inside of a versatile data set.
    /// </summary>
    public class DataDivision
    {
        /// <summary>
        /// The count of items in this partition.
        /// </summary>
        public int Count { get; set; }

        /// <summary>
        /// The percent of items in this partition.
        /// </summary>
        public double Percent { get; private set; }

        /// <summary>
        /// The dataset that we are dividing.
        /// </summary>
        public MatrixMLDataSet Dataset { get; set; }

        /// <summary>
        /// The mask of items we are to use.
        /// </summary>
        public int[] Mask { get; private set; }

        /// <summary>
        /// Construct a division.
        /// </summary>
        /// <param name="thePercent">The desired percentage in this division.</param>
        public DataDivision(double thePercent)
        {
            Percent = thePercent;
        }

        /// <summary>
        /// Allocat space to hold the mask.
        /// </summary>
        /// <param name="theSize">The mask size.</param>
        public void AllocateMask(int theSize)
        {
            Mask = new int[theSize];
        }

    }
}
